LotusScript Doc

Class: LSAEMailItem




Property Summary
Public Property Set Delimiter As String
Public Property Get Delimiter As String
Public Property Set DisplayFormat As String
Public Property Get DisplayFormat As String
Public Property Set EMailAddress As String
Public Property Get EMailAddress As String
Public Property Get Formatted As String
Public Property Set Key As String
Public Property Get Key As String
Public Property Set NotAllowedChars As Variant
Public Property Get NotAllowedChars As Variant

Method Summary
Sub Clear ()
Function CompareTo (CompItem As LSAEMailItem) As Integer
Sub Delete ()
Sub explode (SerializedObj As String)
Function hasAttributeChanged (attrName As String) As Integer
Function hasChanged () As Integer
Function Implode () As String
Function IsEmptyInstance () As Integer
Sub New (newKey As String, newEMailAddress As String)
Sub Validate ()

Property Detail

Public Property Set Key AsString

Sets the description for the e-mail address by which it can be accessed from a list and checks on not allowed characters. Example "Notes" for the Notes e-mail address of a person.

Errors:
ErrDelimiterInField
Summmary Top

Public Property Get Key AsString

Summmary Top

Public Property Set EMailAddress AsString

Sets the e-mail address maintained by this object and checks on not allowed characters.

Errors:
ErrDelimiterInField
Summmary Top

Public Property Get EMailAddress AsString

Summmary Top

Public Property Set Delimiter AsString

When the object is imploded to a serial data string this character will be used as seperator. If the programmer doesn't set a delimiter a default value will be delivered by the class.

Summmary Top

Public Property Get Delimiter AsString

Summmary Top

Public Property Set NotAllowedChars AsVariant

These characters are not allowed to be use in the key and emailaddress properties

Summmary Top

Public Property Get NotAllowedChars AsVariant

Summmary Top

Public Property Set DisplayFormat AsString

The display format is a rule for formatting the object data when the property 'Formatted' is used. The values of the constants EMI_DEFAULT_KEY_NAME and EMI_DEFAULT_EMAIL_NAME has to be used to form the format

Summmary Top

Public Property Get DisplayFormat AsString

Summmary Top

Public Property Get Formatted AsString

Formats the object's data in a user defined way

Summmary Top
Method Detail

New

Public Sub New(newKey As String,newEMailAddress As String)
Sets the properties Key and EMailAddress with the parameter values. Default values for the properties Delimiter, NotAllowedChars and DisplayFormat are set.

Parameters:
newKeyStringthe key of the new object
newEMailAddressStringe-mail address maintained by the new object
Summmary Top

Delete

Public Sub Delete
Summmary Top

Implode

Public Function Implode As String
This method writes the data of the object to a serialized data string. The string should be of the form: ~~~~.

Returns:
Stringserial data string representing the object
Summmary Top

explode

Public Sub explode(SerializedObj As String)
Transforms a string build by the implode method in its components. The string should be in the form ~~ ~ or ~~~~. Old values for Key and EMailAddress are resetted.

Parameters:
serializedObjStringString of the format as delivered by the implode method
Errors:
ErrDataDoesntCorrespondToObject
Summmary Top

Validate

Public Sub Validate
The validate method checks that the properties "Key" and "EMailAddress" aren't empty.

Errors:
ErrAddressTypeEmpty
ErrMailAddressEmpty
Summmary Top

Clear

Public Sub Clear
Clears the values of the e-mail item object. After the usage of clear the method IsEmptyInstance will deliver true as return value.

Summmary Top

IsEmptyInstance

Public Function IsEmptyInstance As Integer
Checks if attributes key and emailaddress are empty strings.

Returns:
Booleantrue, if attributes key and emailaddress are empty
Summmary Top

CompareTo

Public Function CompareTo(CompItem As LSAEMailItem) As Integer
Compares the properties Key and EMailAddress of the EMailItem object.

Parameters:
compItemLSAEMailItemthe object to compare against
Returns:
booleantrue, if objects have same attributes
Summmary Top

hasAttributeChanged

Public Function hasAttributeChanged(attrName As String) As Integer
Checks if the attribute with the name attrName has heen changed

Parameters:
attrNameStringthe name of the attribute to check
Returns:
booleantrue, if the attribute has changed
Summmary Top

hasChanged

Public Function hasChanged As Integer
Checks one of the objects attributes has been changed

Summmary Top

TopLotusScript Doc
© Lotus Professional Services
generated on : 05-Apr-01 8:40:00 AM